This change allows the ngen framework to read a model parameter key in the realization configuration and, once a BMI model has been initialized, it will use Set_value to modify the parameter values of the BMI model to use the ones read from the ngen configuration.

Additions

• a model_params optional key in the configuration input file.
• private JSONProperty::PropertyVariant member
• private JSONProperty::PropertyVistor struct
• public JSONProperty::as_vector() template function
• private helper functions in BMI_Module_Formulation:
  • as_c_array()
  • get_values_as_types()

Removals

Changes

• Formulations now look for and loop through model_params in the passed property tree and attempt to Set_value for those parameter variables.

Testing

1. Tested with ngen_cal to support calibration iterations.
2. Unit tests added (and passed) for JSON Property and BMI_C_Formulation

Screenshots

Notes

• Requires BMI models to enable Set_value for the respective parameter variables.

Todos

• Optimize the handling of data between JSONProperty and Formulation
• Refactor JSONProperty using newly introduced PropertyVariant

Checklist

• PR has an informative and human-readable title
• Changes are limited to a single goal (no scope creep)
• Code can be automatically merged (no conflicts)
• Code follows project standards (link if applicable)
• Passes all existing automated tests
• Any change in functionality is tested
• New functions are documented (with a description, list of inputs, and expected output)
• Placeholder code is flagged / future todos are captured in comments
• Project documentation has been updated (including the "Unreleased" section of the CHANGELOG)
• Reviewers requested with the Reviewers tool ➡️

Target Environment support

• Linux
• MacOS